//------------------------------------------------------------------------------
//  <copyright file="MessageDescription.h" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//  </copyright>
//------------------------------------------------------------------------------

#pragma once

#include "stdafx.h"
#include "KukaLBR4PlusControllerExports.h"
#include "KukaLBR4ControllerCommon.h"

#include <Windows.h>

using namespace KukaLBR4ControllerCommonNS;

/// <summary> Describes a message to or from an upstream client. </summary>
struct KUKALBR4PLUSCONTROLLER_DLLEXPORTIMPORT MessageDescription
{
	/// <summary> Type of message. </summary>
	MessageTypes MessageType;

	/// <summary> Indicates whether or not the message is a response. </summary>
	byte IsResponse;

	/// <summary> Sequence number of the message. </summary>
	unsigned int SequenceNumber;

	/// <summary> Number of bytes used in the currently set parameters </summary>
	unsigned int ParameterLength;

	/// <summary> Length of the <c>parameters</c> buffer. </summary>
	unsigned int ParameterBufferLength;

	/// <summary> Message type specific parameters.
	byte *pParameters;

	/// <summary>
	/// Initializes a new instance of the MessageDescription struct using 0
	/// for the <c>parameters</c> buffer size.
	/// </summary>
	MessageDescription();
	
	/// <summary> Initializes a new instance of the <c>MessageDescription</c> struct. </summary>
	/// <param name="desiredParameterBufferLength"> Length of the parameter buffer to allocate </param>
	MessageDescription(int desiredParameterBufferLength);

	/// <summary> dtor </summary>
	~MessageDescription();
};	
